home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / awf.1 < prev    next >
Text File  |  1995-07-25  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4.      AAAAWWWWFFFF((((1111))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((11113333 JJJJuuuullllyyyy 1111999999990000))))             AAAAWWWWFFFF((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           awf - amazingly workable (text) formatter
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           aaaawwwwffff ----mmmm_a_c_r_o_s [ file ] ...
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.           _A_w_f formats the text from the input _f_i_l_e(s) (standard input
  16.           if none) in an imitation of _n_r_o_f_f's style with the ----mmmmaaaannnn or
  17.           ----mmmmssss macro packages.  The ----mmmm_a_c_r_o option is mandatory and must
  18.           be `-man' or `-ms'.
  19.  
  20.           _A_w_f implements the following raw _n_r_o_f_f requests:
  21.  
  22.                  .\"    .ce     .fi     .in     .ne     .pl     .sp
  23.                  .ad     .de     .ft     .it     .nf     .po     .ta
  24.                  .bp     .ds     .ie     .ll     .nr     .ps     .ti
  25.                  .br     .el     .if     .na     .ns     .rs     .tm
  26.  
  27.           and the following in-text codes:
  28.  
  29.                \$    \%     \*     \c     \f     \n     \s
  30.  
  31.           plus the full list of _n_r_o_f_f/_t_r_o_f_f special characters in the
  32.           original V7 _t_r_o_f_f manual.
  33.  
  34.           Many restrictions are present; the behavior in general is a
  35.           subset of _n_r_o_f_f's.  Of particular note are the following:
  36.  
  37.           o+ Point sizes do not exist; ....ppppssss and \\\\ssss are ignored.
  38.  
  39.           o+ Conditionals implement only numeric comparisons on \\\\nnnn((((....$$$$,
  40.             string comparisons between a macro parameter and a
  41.             literal, and nnnn (always true) and tttt (always false).
  42.  
  43.           o+ The implementation of strings is generally primitive.
  44.  
  45.           o+ Expressions in (e.g.) ....sssspppp are fairly general, but the ||||,
  46.             &&&&, and :::: operators do not exist, and the implementation of
  47.             \\\\wwww requires that quote (') be used as the delimiter and
  48.             simply counts the characters inside (so that, e.g.,
  49.             \w'\(bu' equals 4).
  50.  
  51.           White space at the beginning of lines, and imbedded white
  52.           space within lines, is dealt with properly.  Sentence
  53.           terminators at ends of lines are understood to imply extra
  54.           space afterward in filled lines.  Tabs are implemented
  55.           crudely and not quite correctly, although in most cases they
  56.           work as expected.  Hyphenation is done only at explicit
  57.           hyphens, em-dashes, and _n_r_o_f_f discretionary hyphens.
  58.  
  59.      MMMMAAAANNNN MMMMAAAACCCCRRRROOOOSSSS
  60.  
  61.  
  62.  
  63.      PPPPaaaaggggeeee 1111                                          ((((pppprrrriiiinnnntttteeeedddd 6666////33330000////99995555))))
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      AAAAWWWWFFFF((((1111))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((11113333 JJJJuuuullllyyyy 1111999999990000))))             AAAAWWWWFFFF((((1111))))
  71.  
  72.  
  73.  
  74.           The ----mmmmaaaannnn macro set implements the full V7 manual macros,
  75.           plus a few semi-random oddballs.  The full list is:
  76.  
  77.                .B   .DT     .IP     .P      .RE     .SM
  78.                .BI  .HP     .IR     .PD     .RI     .TH
  79.                .BR  .I      .LP     .PP     .RS     .TP
  80.                .BY  .IB     .NB     .RB     .SH     .UC
  81.  
  82.           ....BBBBYYYY and ....NNNNBBBB each take a single string argument
  83.           (respectively, an indication of authorship and a note about
  84.           the status of the manual page) and arrange to place it in
  85.           the page footer.
  86.  
  87.      MMMMSSSS MMMMAAAACCCCRRRROOOOSSSS
  88.           The ----mmmmssss macro set is a substantial subset of the V7
  89.           manuscript macros.  The implemented macros are:
  90.  
  91.                .AB  .CD     .ID     .ND     .QP     .RS     .UL
  92.                .AE  .DA     .IP     .NH     .QS     .SH     .UX
  93.                .AI  .DE     .LD     .NL     .R      .SM
  94.                .AU  .DS     .LG     .PP     .RE     .TL
  95.                .B   .I      .LP     .QE     .RP     .TP
  96.  
  97.           Size changes are recognized but ignored, as are ....RRRRPPPP and ....NNNNDDDD.
  98.           ....UUUULLLL just prints its argument in italics.  ....DDDDSSSS/....DDDDEEEE does not
  99.           do a keep, nor do any of the other macros that normally
  100.           imply keeps.
  101.  
  102.           Assignments to the header/footer string variables are
  103.           recognized and implemented, but there is otherwise no
  104.           control over header/footer formatting.  The DDDDYYYY string
  105.           variable is available.  The PPPPDDDD, PPPPIIII, and LLLLLLLL number registers
  106.           exist and can be changed.
  107.  
  108.      OOOOUUUUTTTTPPPPUUUUTTTT
  109.           The only output format supported by _a_w_f, in its distributed
  110.           form, is that appropriate to a dumb terminal, using
  111.           overprinting for italics (via underlining) and bold.  The
  112.           _n_r_o_f_f special characters are printed as some vague
  113.           approximation (it's sometimes very vague) to their correct
  114.           appearance.
  115.  
  116.           _A_w_f's knowledge of the output device is established by a
  117.           device file, which is read before the user's input.  It is
  118.           sought in _a_w_f's library directory, first as ddddeeeevvvv...._t_e_r_m (where
  119.           _t_e_r_m is the value of the TERM environment variable) and,
  120.           failing that, as ddddeeeevvvv....dddduuuummmmbbbb.  The device file uses special
  121.           internal commands to set up resolution, special characters,
  122.           fonts, etc., and more normal _n_r_o_f_f commands to set up page
  123.           length etc.
  124.  
  125.      FFFFIIIILLLLEEEESSSS
  126.  
  127.  
  128.  
  129.      PPPPaaaaggggeeee 2222                                          ((((pppprrrriiiinnnntttteeeedddd 6666////33330000////99995555))))
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      AAAAWWWWFFFF((((1111))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((11113333 JJJJuuuullllyyyy 1111999999990000))))             AAAAWWWWFFFF((((1111))))
  137.  
  138.  
  139.  
  140.           All in /_u_s_r/_s_k_u_n_k/_l_i_b/_a_w_f (this can be overridden by the
  141.           AWFLIB environment variable):
  142.  
  143.           common common device-independent initialization
  144.           dev.*  device-specific initialization
  145.           mac.m* macro packages
  146.           pass1  macro substituter
  147.           pass2.base     central formatter
  148.           pass2.m*       macro-package-specific bits of formatter
  149.           pass3  line and page composer
  150.  
  151.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  152.           awk(1), nroff(1), man(7), ms(7)
  153.  
  154.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  155.           Unlike _n_r_o_f_f, _a_w_f complains whenever it sees unknown
  156.           commands and macros.  All diagnostics (these and some
  157.           internal ones) appear on standard error at the end of the
  158.           run.
  159.  
  160.      HHHHIIIISSSSTTTTOOOORRRRYYYY
  161.           Written at University of Toronto by Henry Spencer,  more  or
  162.           less as a supplement to the C News project.
  163.  
  164.                 => None of the above really want to admit it. <=
  165.  
  166.      BBBBUUUUGGGGSSSS
  167.           There are  plenty,  but  what  do  you  expect  for  a  text
  168.           formatter written entirely in (old) _a_w_k?
  169.  
  170.           The ----mmmmssss stuff has not been checked out very thoroughly.
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 6/30/95)
  196.  
  197.  
  198.  
  199.